| gaomingcode/jquery.spinner | 您所在的位置：网站首页 › jquery create input element › gaomingcode/jquery.spinner |
gaomingcode/jquery.spinner
|
README
A Bootstrap / jQuery plugin to create input spinner elements for number input. Demo page with examples
This version is compatible with Bootstrap 5, but we remain a Bootstrap 4 compatible version with the branch bootstrap4-compatible. npm package versions 3.x are Bootstrap 5 compatible, versions 2.x Bootstrap 4 compatible. Current, Bootstrap 5 compatible npm package Boostrap 4 compatible npm package FeaturesThe Bootstrap InputSpinner is mobile friendly and responsive, automatically changes the value when holding a button, has internationalized number formatting, allows setting a prefix or a suffix text in the input, handles val() like the native element, dynamically handles changing attribute values like disabled or class, supports templates and custom editors, (new!) dispatches change and input events on value change like the native element and works without extra css, only Bootstrap 5 is needed. Quickstart InstallationCurrent version, Bootstrap 5 compatible npm install bootstrap-input-spinnerBootstrap 4 compatible version nom install [email protected]Or just download the GitHub repository and include src/bootstrap-input-spinner.js. HTMLCreate the element in HTML. The attributes are compatible to the native input[type="number"] element. ScriptIt is a jQuery plugin. So, enable the InputSpinner for all inputs with type='number' with the following script. $("input[type='number']").inputSpinner();That's it. No extra css needed, just Bootstrap 5 and jQuery. API Reference HTML AttributesUse these attributes to configure the behaviour value // starting value on element creation min // minimum value when stepping max // maximum value when stepping step // step size inputmode // the "inputmode" of the input, defaults to "decimal" (shows decimal keyboard on touch devices) data-decimals // shown decimal places data-digit-grouping // "false" to disable grouping (thousands separator), default is "true" data-prefix // show a prefix text in the input element data-suffix // show a suffix text in the input elementThe InputSpinner also handles the standard input attributes required, disabled, readonly and placeholder. Create an instance in JavaScriptUse JavaScript to create the instance as a jQuery plugin. You may provide additional configuration in an object as a config parameter. $(element).inputSpinner(config); Configuration (props)The default configuration is var props = { decrementButton: "−", // button text incrementButton: "+", // .. groupClass: "", // css class of the resulting input-group buttonsClass: "btn-outline-secondary", buttonsWidth: "2.5rem", textAlign: "center", // alignment of the entered number autoDelay: 500, // ms threshold before auto value change autoInterval: 50, // speed of auto value change buttonsOnly: false, // set this `true` to disable the possibility to enter or paste the number via keyboard keyboardStepping: true, // set this to `false` to disallow the use of the up and down arrow keys to step locale: navigator.language, // the locale, per default detected automatically from the browser editor: I18nEditor, // the editor (parsing and rendering of the input) template: // the template of the input '' + '${decrementButton}' + '' + '${incrementButton}' + '' } decrementButton, incrementButtonHTML of the texts inside the buttons. groupClassAdditional css class for the input-group of the rendered Bootstrap input. buttonsClassThe css class of the buttons. Use it to style the increment and decrement buttons as described here. Maybe buttonsClass: btn-primary or btn-success or whatever type of buttons you want. buttonsWidthThe width of the increment and decrement buttons. textAlignThe text alignment inside the . autoDelayThe delay in ms after which the input automatically changes the value, when holding the increment or decrement button. autoIntervalSpeed of the value change when holding the button in ms. A lower value makes it faster. buttonsOnlyIn buttonsOnly mode (set true) no direct text input is allowed, the text-input gets the attribute readonly, but the plus and minus buttons still allow to change the value. keyboardSteppingIn keyboardStepping mode (set true) allows the use of the up/down arrow keys to increase/decrease the number by the step. localeUsed to format the number in the UI. Detected automatically from the user's browser, can be set to "de", "en",… or " de_DE", "en_GB",…. editor (new!)An Editor defines, how the input is parsed and rendered. The default editor of the spinner is the I18nEditor, which renders and parses an internationalized number value. There are custom editors in /src/custom-editors.js. An Editor must implement the two functions parse(customValue), to parse the input to a number and render(number) to render the number to the spinner input. The simplest custom Editor is the RawEditor, it renders just the value und parses just the value, without any changes, like a native number input. It looks like this: var RawEditor = function (props, element) { this.parse = function (customFormat) { // parse nothing return customFormat } this.render = function (number) { // render raw return number } }props is the configuration of the spinner and element is the original HTML element. You can use these values for the configuration of the Editor, like in I18nEditor, which uses props for the language and element for the attributes. The TimeEditor renders and parses the number to time in hours and minutes, separated by a colon.
To modify the look completely, you can use the template parameter. There is an example about this on the Demo Page. Programmatic change and read of valueTo change or read the value just use the jQuery val() function on the input, like this var currentValue = $(element).val() // read $(element).val(newValue) // writeHint: Reading the value in vanilla JS with element.value will also work, but to set the value you have to use element.setValue(newValue) or $(element).val(newValue) Handling attributesThe attributes min, max, step, decimals, placeholder, required, disabled, readonly and class are handled dynamically. The class attribute value is dynamically copied to the input element. SizingIf the original elements class is set to form-control-sm of form-control-lg the class of the resulting input-group is dynamically set to input-group-sm or input-group-lg. EventsThe InputSpinner handles input and change events like the native element. Event handling with vanilla JavaScript element.addEventListener("change", function (event) { newValue = this.value }) Event handling with jQuery syntax $(element).on("change", function (event) { newValue = $(this).val() }) MethodsMethods are passed as string values instead of the options object. destroyRemoves the InputSpinner and shows the original input element. $(element).inputSpinner("destroy") Minified versionI don't provide a minified version because I think it should be up to the using programmer to create minified versions, with all the used script sources concatenated to one file. But, if you want it, it is easy to create your minified version with uglify: https://www.npmjs.com/package/uglify-js Just install uglify npm install uglify-js -gand then in the src-folder uglifyjs bootstrap-input-spinner.js --compress --mangle > bootstrap-input-spinner.min.jsViolà! :) Browser supportThe spinner works in all modern browsers and in the Internet Explorer. Not tested with IE < 11. For older browsers (IE 9 or so), that doesn't support Intl, when you get an error message like "Intl is not defined" (See issue #34), just use a shim or polyfill like Intl.js, and it works. Our further Bootstrap and HTML extensionsIf you like this component, you may want to check out our other Bootstrap and HTML extensions bootstrap-show-modal, bootstrap-detect-breakpoint, auto-resize-textarea and external-links-blank. |
【本文地址】